<!DOCTYPE HTML>

<html lang="en">
<head>

<title>SavedRequestAwareAuthenticationSuccessHandler (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="SavedRequestAwareAuthenticationSuccessHandler (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="SavedRequestAwareAuthenticationSuccessHandler.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web.authentication</a></div>
<h2 title="Class SavedRequestAwareAuthenticationSuccessHandler" class="title">Class SavedRequestAwareAuthenticationSuccessHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AbstractAuthenticationTargetUrlRequestHandler.html" title="class in org.springframework.security.web.authentication">org.springframework.security.web.authentication.AbstractAuthenticationTargetUrlRequestHandler</a></li>
<li>
<ul class="inheritance">
<li><a href="SimpleUrlAuthenticationSuccessHandler.html" title="class in org.springframework.security.web.authentication">org.springframework.security.web.authentication.SimpleUrlAuthenticationSuccessHandler</a></li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="AuthenticationSuccessHandler.html" title="interface in org.springframework.security.web.authentication">AuthenticationSuccessHandler</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SavedRequestAwareAuthenticationSuccessHandler</span>
extends <a href="SimpleUrlAuthenticationSuccessHandler.html" title="class in org.springframework.security.web.authentication">SimpleUrlAuthenticationSuccessHandler</a></pre>
<div class="block">An authentication success strategy which can make use of the
<a href="../savedrequest/DefaultSavedRequest.html" title="class in org.springframework.security.web.savedrequest"><code>DefaultSavedRequest</code></a> which may
have been stored in the session by the <a href="../access/ExceptionTranslationFilter.html" title="class in org.springframework.security.web.access"><code>ExceptionTranslationFilter</code></a>. When such a
request is intercepted and requires authentication, the request data is stored to
record the original destination before the authentication process commenced, and to
allow the request to be reconstructed when a redirect to the same URL occurs. This
class is responsible for performing the redirect to the original URL if appropriate.
<p>
Following a successful authentication, it decides on the redirect destination, based on
the following scenarios:
<ul>
<li>If the <code>alwaysUseDefaultTargetUrl</code> property is set to true, the
<code>defaultTargetUrl</code> will be used for the destination. Any
<code>DefaultSavedRequest</code> stored in the session will be removed.</li>
<li>If the <code>targetUrlParameter</code> has been set on the request, the value will be
used as the destination. Any <code>DefaultSavedRequest</code> will again be removed.</li>
<li>If a <a href="../savedrequest/SavedRequest.html" title="interface in org.springframework.security.web.savedrequest"><code>SavedRequest</code></a> is found in
the <code>RequestCache</code> (as set by the <a href="../access/ExceptionTranslationFilter.html" title="class in org.springframework.security.web.access"><code>ExceptionTranslationFilter</code></a> to record
the original destination before the authentication process commenced), a redirect will
be performed to the Url of that original destination. The <code>SavedRequest</code> object
will remain cached and be picked up when the redirected request is received (See
<a href="https://docs.spring.io/spring-security/site/docs/current/api/org/springframework/security/web/savedrequest/SavedRequestAwareWrapper.html">SavedRequestAwareWrapper</a>).
</li>
<li>If no <a href="../savedrequest/SavedRequest.html" title="interface in org.springframework.security.web.savedrequest"><code>SavedRequest</code></a> is found,
it will delegate to the base class.</li>
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.commons.logging.Log</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SavedRequestAwareAuthenticationSuccessHandler.html#logger">logger</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="SavedRequestAwareAuthenticationSuccessHandler.html#%3Cinit%3E()">SavedRequestAwareAuthenticationSuccessHandler</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SavedRequestAwareAuthenticationSuccessHandler.html#onAuthenticationSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">onAuthenticationSuccess</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;authentication)</code></th>
<td class="colLast">
<div class="block">Calls the parent class <code>handle()</code> method to forward or redirect to the target
URL, and then calls <code>clearAuthenticationAttributes()</code> to remove any leftover
session data.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SavedRequestAwareAuthenticationSuccessHandler.html#setRequestCache(org.springframework.security.web.savedrequest.RequestCache)">setRequestCache</a></span>&#8203;(<a href="../savedrequest/RequestCache.html" title="interface in org.springframework.security.web.savedrequest">RequestCache</a>&nbsp;requestCache)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.web.authentication.SimpleUrlAuthenticationSuccessHandler">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.security.web.authentication.<a href="SimpleUrlAuthenticationSuccessHandler.html" title="class in org.springframework.security.web.authentication">SimpleUrlAuthenticationSuccessHandler</a></h3>
<code><a href="SimpleUrlAuthenticationSuccessHandler.html#clearAuthenticationAttributes(javax.servlet.http.HttpServletRequest)">clearAuthenticationAttributes</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.web.authentication.AbstractAuthenticationTargetUrlRequestHandler">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.security.web.authentication.<a href="AbstractAuthenticationTargetUrlRequestHandler.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationTargetUrlRequestHandler</a></h3>
<code><a href="AbstractAuthenticationTargetUrlRequestHandler.html#determineTargetUrl(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">determineTargetUrl</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#determineTargetUrl(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">determineTargetUrl</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#getDefaultTargetUrl()">getDefaultTargetUrl</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#getRedirectStrategy()">getRedirectStrategy</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#getTargetUrlParameter()">getTargetUrlParameter</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#handle(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">handle</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#isAlwaysUseDefaultTargetUrl()">isAlwaysUseDefaultTargetUrl</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#setAlwaysUseDefaultTargetUrl(boolean)">setAlwaysUseDefaultTargetUrl</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#setDefaultTargetUrl(java.lang.String)">setDefaultTargetUrl</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#setRedirectStrategy(org.springframework.security.web.RedirectStrategy)">setRedirectStrategy</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#setTargetUrlParameter(java.lang.String)">setTargetUrlParameter</a>, <a href="AbstractAuthenticationTargetUrlRequestHandler.html#setUseReferer(boolean)">setUseReferer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.web.authentication.AuthenticationSuccessHandler">

</a>
<h3>Methods inherited from interface&nbsp;org.springframework.security.web.authentication.<a href="AuthenticationSuccessHandler.html" title="interface in org.springframework.security.web.authentication">AuthenticationSuccessHandler</a></h3>
<code><a href="AuthenticationSuccessHandler.html#onAuthenticationSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,javax.servlet.FilterChain,org.springframework.security.core.Authentication)">onAuthenticationSuccess</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="logger">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre>protected final&nbsp;org.apache.commons.logging.Log logger</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SavedRequestAwareAuthenticationSuccessHandler</h4>
<pre>public&nbsp;SavedRequestAwareAuthenticationSuccessHandler()</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="onAuthenticationSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>onAuthenticationSuccess</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onAuthenticationSuccess&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                                    javax.servlet.http.HttpServletResponse&nbsp;response,
                                    <a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;authentication)
                             throws javax.servlet.ServletException,
                                    java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SimpleUrlAuthenticationSuccessHandler.html#onAuthenticationSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">SimpleUrlAuthenticationSuccessHandler</a></code></span></div>
<div class="block">Calls the parent class <code>handle()</code> method to forward or redirect to the target
URL, and then calls <code>clearAuthenticationAttributes()</code> to remove any leftover
session data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AuthenticationSuccessHandler.html#onAuthenticationSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">onAuthenticationSuccess</a></code>&nbsp;in interface&nbsp;<code><a href="AuthenticationSuccessHandler.html" title="interface in org.springframework.security.web.authentication">AuthenticationSuccessHandler</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="SimpleUrlAuthenticationSuccessHandler.html#onAuthenticationSuccess(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.Authentication)">onAuthenticationSuccess</a></code>&nbsp;in class&nbsp;<code><a href="SimpleUrlAuthenticationSuccessHandler.html" title="class in org.springframework.security.web.authentication">SimpleUrlAuthenticationSuccessHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the request which caused the successful authentication</dd>
<dd><code>response</code> - the response</dd>
<dd><code>authentication</code> - the <tt>Authentication</tt> object which was created during
the authentication process.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code></dd>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="setRequestCache(org.springframework.security.web.savedrequest.RequestCache)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setRequestCache</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRequestCache&#8203;(<a href="../savedrequest/RequestCache.html" title="interface in org.springframework.security.web.savedrequest">RequestCache</a>&nbsp;requestCache)</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="SavedRequestAwareAuthenticationSuccessHandler.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="SavedRequestAwareAuthenticationSuccessHandler.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040cc43df26980c","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
